Conversation
yadij
commented
Mar 25, 2025
yadij
commented
- Fix documentation of 0x01 line terminators (reply only).
- Fix table display.
- Add missing concurrency channel documentation and fix related example syntax.
- Fix various grammar, spelling and typos.
* Fix documentation of 0x01 line terminators (reply only). * Fix table display * Add missing concurrency channel documentation and fix related example syntax. * Fix various grammar, spelling and typos
| *line* refers to a logical input. **body** may contain \\n characters so | ||
| each line in this format is delimited by a 0x01 byte instead of the | ||
| standard \\n byte. | ||
| *`line`* refers to a logical input. **`kv-pairs`** may contain `\n` characters so |
There was a problem hiding this comment.
Please be consistent in formatting "kv-pairs" and similar references, at least in new/modified text. Currently, PR uses a mixture of different formatting approaches, including bold, code, bold code, and plain formatting. I recommend using code formatting for BNF parts like kv-pairs.
| standard \\n byte. | ||
| *`line`* refers to a logical input. **`kv-pairs`** may contain `\n` characters so | ||
| each request message is composed by appending `\n`-terminated lines (including | ||
| those `\n` characters) until **`size`** bytes have been received. |
There was a problem hiding this comment.
Please rephrase to avoid "composed until received" phrasing. I recommend dropping the entire "so ..." part and describing kv-pairs and other formatting details (if needed) instead (in a paragraph/blob separate from this "warning" and using BNF where practical).
Similar concerns apply to the response description further below.
| @@ -62,29 +62,39 @@ This interface is similar to the SSL certificate generation interface. | |||
|
|
|||
| Input *line* received from Squid: | |||
There was a problem hiding this comment.
Avoid the term "line" (that we have to warn about):
| Input *line* received from Squid: | |
| Request sent by Squid: |
| Input *line* received from Squid: | |
| Squid sends requests that use the following format: |
... and replace "request" with "command" or similar in the BNF and BNF definitions below.
2 participants
